﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Diagnostics.Contracts;
using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет методы расширения для интерфейса <c>IRobotHardware</c>.
    /// </summary>
    /// <seealso cref="IRobotHardware"/>
    public static class IRobotHardwareMeasureExtensions
    {
        #region Extension Methods

        /// <summary>
        /// Перемещает робота вперед на 360 градусов для каждого колеса.
        /// Расстояние, на которое он переместится после вызова метода, должно быть замерено вручную
        /// и установлено в качестве свойства <c>IRobotHardwareOptions.WheelRunDistance</c>.
        /// </summary>
        /// <param name="hardware">Интерфейс доступа к двигателю робота, при помощи которого осуществляется движение.</param>
        /// <param name="options">Настройки, при помощи которых указанный интерфейс доступа к двигателю робота был инициализирован.</param>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="IRobotHardwareOptions"/>
        public static void MeasureWheelRunDistance(
            this IRobotHardware hardware,
            IRobotHardwareOptions options)
        {
            Contract.Requires(hardware != null);
            Contract.Requires(options != null);
            hardware.Engine.Move(
                options.WheelRunDistance,
                MovementDirection.Forward);
        }

        /// <summary>
        /// Перемещает колеса робота на <c>IRobotHardwareOptions.LeftTurnTacho</c> градусов,
        /// если параметр <paramref name="rotationDirection"/> установлен как <c>CounterClockwise</c>,
        /// или на <c>IRobotHardwareOptions.RightTurnTacho</c> градусов,
        /// если параметр <paramref name="rotationDirection"/> установлен как <c>Clockwise</c>.
        /// <para>Перед вызовом метода необходимо установить такое значение указанных свойств интерфейса
        /// <c>IRobotHardwareOptions</c>, чтобы робот в действительности осуществлял полный оборот вокруг своей оси.
        /// </para>
        /// </summary>
        /// <param name="hardware">Интерфейс доступа к двигателю робота, при помощи которого осуществляется поворот.</param>
        /// <param name="options">Настройки, при помощи которых указанный интерфейс доступа к двигателю робота был инициализирован.</param>
        /// <param name="rotationDirection">Направление поворота робота, определяющего задействуемые свойства интерфейса <c>IRobotHardwareOptions</c>.</param>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="IRobotHardwareOptions"/>
        /// <seealso cref="RotationDirection"/>
        public static void MeasureFullTurnTime(
            this IRobotHardware hardware,
            IRobotHardwareOptions options,
            RotationDirection rotationDirection)
        {
            Contract.Requires(hardware != null);
            Contract.Requires(options != null);
            Contract.Requires(Enum.IsDefined(typeof(RotationDirection), rotationDirection));
            // полный оборот за один раз сделать невозможно из-за нормализации угла поворота
            const int timesToTurn = 2;
            Angle singleTurnAngle = Angle.DefineInDegree(360 / timesToTurn);
            for (int i = 0; i < timesToTurn; i++)
            {
                hardware.Engine.Rotate(singleTurnAngle, rotationDirection);
            }
        }

        #endregion
    }
}
